home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / ggraph / RCS / ggraph.man,v < prev    next >
Text File  |  1990-01-22  |  8KB  |  300 lines
  1. head     1.3;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.3
  10. date     90.01.22.14.04.25;  author shirriff;  state Exp;
  11. branches ;
  12. next     1.2;
  13.  
  14. 1.2
  15. date     90.01.02.00.36.27;  author tve;  state Exp;
  16. branches ;
  17. next     1.1;
  18.  
  19. 1.1
  20. date     90.01.02.00.34.54;  author tve;  state Exp;
  21. branches ;
  22. next     ;
  23.  
  24.  
  25. desc
  26. @original
  27. @
  28.  
  29.  
  30. 1.3
  31. log
  32. @Made man page somewhat up to date.
  33. @
  34. text
  35. @.TH GGRAPH 1 "1 March 1986"
  36. .SH NAME
  37. ggraph
  38. .SH SYNOPSIS
  39. .PD 0
  40. .B "ggraph [input file [output file]]"
  41. .IP " " 5
  42. .RS
  43. .IP "\fBinput file" 12
  44. is the \fIggraph\fR input file.  If omitted, stdin is read.
  45. .IP "\fBoutput file" 12
  46. is the \fIggraph\fR output file.  If omitted, the file name is given
  47. in the \fIdra\fR command described below.  This is the preferred usage.
  48. .RE
  49. .PD .3
  50. .SH DESCRIPTION
  51. .PP
  52. \fIGgraph\fP is a program which will take points and produce gremlin
  53. files which may be displayed by \fIgremlin\fP or included in
  54. \fIditroff\fP documents.  \fIGgraph\fP takes as input \fIggraph\fP
  55. files and produces SUN gremlin files.  The minimum amount of
  56. information needed is a set of X and Y coordinates.  \fIGgraph\fP will
  57. automatically scale the points to fit the graph area.  Currently, four
  58. types of graphs are supported: linear (including curves), log graphs,
  59. histograms and bar graphs.  In addition all of the line types
  60. supported by \fIgremlin\fP are supported by \fIggraph\fP.
  61. \fIGgraph\fP is currently under development and therefore new features
  62. will be added from time to time.  In addition backwards compatibility
  63. is \fInot\fP guaranteed at this time.
  64. .PP
  65. A \fIggraph\fP input file is an ASCII file containing \fIggraph\fP
  66. commands and data.  Each command is on a separate line.  Blank lines
  67. may be inserted as separators with no problem.  The coordinates for the
  68. points of the graph are read as floats.  Whitespace may be used
  69. arbitrarily to seperate different elements of a line. Lastly, a
  70. semicolon is a comment character causing the rest of the line to be
  71. ignored.
  72. .sp
  73. .PP
  74. The following is a list of the \fIggraph\fR commands:
  75. .sp
  76. .ta 6m +1m +\w'<line name> <X pos> <Y pos> 'u +8m
  77. .nf
  78. .ul 1
  79. Command       Arguments    Meaning
  80.  com        <rest of line>    Comment             
  81.  cro        on|off    Turn on X/Y cross hair
  82.  crx        on|off    Turn on X axis cross hair
  83.  cry        on|off    Turn on Y axis cross hair
  84.  dae            Data set end        
  85.  das        <string>    Data start          
  86.  dra        <output file name>    Draw graph          
  87.  fir        on|off    First tick mark both axises on/off     
  88.  fra        on|off    Frame on or off 
  89.  frt        <size #>    Frame thickness
  90.  gti        <string>    Graph title          
  91.  gtp        <X pos> <Y pos>    Graph title position
  92.  lcu        <line name> <curve type>    Curve type           
  93.  leg        on|off    Turn on legend       
  94.  leb        on|off    Draw box around legend       
  95.  les        on/off    Legend position - right side/bottom
  96.  lla        <line name> on|off    Line label on/off   
  97.  llf        <font #>    Line label font
  98.  lls        <size #>    Line label size
  99.  llp        <line name> <X pos> <Y pos>    Line label position 
  100.  lof        <line name> on|off    Line on/off          
  101.  log        on|off    Log-log graph        
  102.  lox        on|off    X coordinates log    
  103.  loy        on|off    Y coordinates log    
  104.  lsy        <line name> <symbol #>    Line symbol          
  105.  lth        <size #>    Line thickness
  106.  lty        <line name> <type #>    Line type            
  107.  qui            Quit
  108.  rea        <file name>    Read a command file  
  109.  sla        <line name> <string>    Line label string   
  110.  sle        <line name> <label>    Set legend line label for a line       
  111.  slf        <font #>    Set legend title font       
  112.  slh        <label>    Set legend string       
  113.  sls        <size #>    Set legend title character size       
  114.  ssw        on|off    Symbols on or off    
  115.  sun        <value>    Set graph units
  116.  sxt        <min X value> <max X value> <number of ticks>
  117.             Set X axis scaling 
  118. .sp .3
  119.  syt        <min Y value> <max Y value> <number of ticks>
  120.             Set Y axis scaling   
  121. .sp .3
  122.  syz        <size #>    Set symbol size          
  123.  tif        on|off    Graph title on/off   
  124.  typ        <type #>    Type of graph        
  125.  ver        on|off    Y label vertical     
  126.  tft        <font #>    Title font           
  127.  tis        <size #>    Title text size      
  128.  xax        on|off|top|bottom|both    X axis on/off and position       
  129.  yax        on|off|left|right|both    Y axis on/off and position
  130.  xfi        on|off    First tick mark X axis on/off      
  131.  yfi        on|off    First tick mark Y axis on/off      
  132.  xft        <font #>    X label font         
  133.  yft        <font #>    Y label font         
  134.  xle        <length>    X axis length in units
  135.  yle        <length>    Y axis length in units
  136.  xgr        on|off    X grid on/off        
  137.  ygr        on|off    Y grid on/off        
  138.  xgt        <grid #>    X grid type          
  139.  ygt        <grid #>    Y grid type          
  140.  xla        <string>    X label              
  141.  yla        <string>    Y label              
  142.  xpr        <#> <#>    Precision for X tick labels            
  143.  ypr        <#> <#>    Precision for Y tick labels            
  144.  xst        <# of tick> [<delta> [<starting tick> [<dev org>]]]
  145.             Set X scaling (obsolete)
  146. .sp .3
  147.  yst        <# of tick> [<delta> [<starting tick> [<dev org>]]]
  148.             Set Y scaling (obsolete)
  149. .sp .3
  150.  xtf        <font #>    Set X tick label font               
  151.  ytf        <font #>    Set Y tick label font               
  152.  xtp        <X pos> <Y pos>    X label position
  153.  ytp        <X pos> <Y pos>    Y label position
  154.  xti        on|off|in|out|both    X ticks on/off       
  155.  yti        on|off|in|out|both    Y ticks on/off       
  156.  xtl        on|off    X label on/off       
  157.  ytl        on|off    Y label on/off       
  158.  xts        <size #>    X label text size    
  159.  yts        <size #>    Y label text size    
  160.  xtz        <size #>    Set X tick label character size               
  161.  ytz        <size #>    Set Y tick label character size               
  162. .fi
  163. .sp
  164. .PP
  165. There are seven line types supported by \fIggraph\fP and
  166. \fIgremlin\fP.  They are:
  167. .RS
  168. .nf
  169. BRUSH_INVISIBLE  0
  170. BRUSH_DOT        1
  171. BRUSH_ALT        2
  172. BRUSH_THICK      3
  173. BRUSH_DASH       4
  174. BRUSH_THIN       5
  175. BRUSH_NORMAL     6
  176. .fi
  177. .RE
  178. .sp
  179. .PP
  180. There are four fonts defined in \fIggraph\fP and \fIgremlin\fP.  These
  181. may be changed arbitrarily with \fIgrn\fP when the graph is printed.
  182. The fonts are:
  183. .RS
  184. .nf
  185. ROMAN       1
  186. ITALICS     2
  187. BOLD        3
  188. SPECIAL     4
  189. .fi
  190. .RE
  191. .sp
  192. .PP
  193. There are four font sizes supported by \fIggraph\fP and \fIgremlin\fP.
  194. See the \fIgremlin\fP manual for their comparative sizes.
  195. .RS
  196. .nf
  197. SMALL       1
  198. MEDIUM      2
  199. LARGE       3
  200. EXLARGE     4
  201. .fi
  202. .RE
  203. .sp
  204. .PP
  205. There are currently eleven symbols defined.  They are:
  206. .RS
  207. .nf
  208. NOSYMBOL        0
  209. BOX             1
  210. RING            2
  211. CROSS           3
  212. STAR            4
  213. TRIANGLE        5
  214. UTRIANGLE       6
  215. CROSSBOX        7
  216. STARBOX         8
  217. DIAMOND         9
  218. CROSSDIAMOND   10
  219. .fi
  220. .RE
  221. .sp 
  222. .SH FILES
  223. .PP
  224. None
  225. .SH AUTHOR
  226. Ed Hunter (edh@@Sun.COM)
  227. .SH SEE ALSO
  228. gremlin (l), grn (l), ditroff (l), pic (l)
  229. .SH BUGS
  230. .PP
  231. N/A
  232. .PP
  233. .ne 27
  234. .SH EXAMPLE
  235. .PP
  236. The following is a simple \fIggraph\fR input file:
  237. .sp
  238. .RS
  239. .nf
  240. com Sample ggraph input file
  241. xla Repetition count                   ;set the X axis label
  242. yla Sec                                ;set the Y axis label
  243. gti Total time by packet count         ;set the graph title
  244. das foo                                ;define a data set foo
  245. 500 4                                  ;data points X, Y
  246. 1000 8
  247. 5000 53
  248. 9000 82
  249. dae                                   ;end the dataset
  250. das bar                               ;start another dataset bar
  251. 500 6
  252. 1000 12
  253. 5000 59
  254. 9000 105
  255. dae                                   ;end the dataset
  256. syz 5                                 ;set symbol size to 4
  257. dra graph1                            ;draw a graph in file graph1
  258. sxt 0.0 10000.0 10                    ;set X axis scaling
  259. syt 0.0 200.0 10                      ;set Y axis scaling
  260. xgr off                               ;turn off X grid
  261. ygr off                               ;turn off Y grid
  262. lof foo off                           ;turn off line foo
  263. fra off                               ;turn the frame off
  264. dra graph2                            ;draw another graph
  265. .fi
  266. .RE
  267. @
  268.  
  269.  
  270. 1.2
  271. log
  272. @les command described incorrectly
  273. @
  274. text
  275. @a45 2
  276.  clx        [<min value> [<max value>]]    Clip the X axis    
  277.  cly        [<min value> [<max value>]]    Clip the Y axis    
  278. d55 1
  279. d57 1
  280. d63 2
  281. d71 1
  282. d73 1
  283. a73 1
  284.  rat        <X> <Y>    Aspect ratio         
  285. d81 1
  286. d100 2
  287. d118 2
  288. @
  289.  
  290.  
  291. 1.1
  292. log
  293. @Initial revision
  294. @
  295. text
  296. @d61 1
  297. a61 1
  298.  les        sid|bot    Legend position - right side or bottom
  299. @
  300.